using System;
using Microsoft.SPOT.Hardware;
using Gadgeteer.Modules;

/*
 * Original Gadgeteer framework Copyright (c) Microsoft Corporation. (http://gadgeteer.codeplex.com/)
 * 
 * Gadgeteer Light made by Stefan Thoolen (http://gadgeteerlight.codeplex.com/)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Gadgeteer.Interfaces
{
    /// <summary>Wrapper for a PWM output port</summary>
    public class PWMOutput
    {
        /// <summary>The actual PWM output port</summary>
        private PWMOutProvider _port = null;

        /// <summary>Sets/gets if the PWM is active</summary>
        public bool Active
        {
            get { return this._port.Active; }
            set { this._port.Active = value; }
        }

        /// <summary>Creates a new PWM output port</summary>
        /// <param name="socket">The socket on which the port exists</param>
        /// <param name="pin">The pin #</param>
        /// <param name="module">The module driving this pin</param>
        public PWMOutput(Socket socket, Socket.Pin pin, Module module)
        {
            this._port = Board.Hardware.GetPWMOutProvider(socket.SocketNumber, (int)pin);
        }
        
        /// <summary>Sets the frequency and dutycycle</summary>
        /// <param name="frequency">frequency</param>
        /// <param name="dutyCycle">dutycycle</param>
        public void Set(int frequency, byte dutyCycle)
        {
            this._port.Set(frequency, dutyCycle);
        }

        /// <summary>Sets the period and hightime</summary>
        /// <param name="period_ns">period</param>
        /// <param name="highTime_ns">hightime</param>
        public void SetPulse(uint period_ns, uint highTime_ns)
        {
            this._port.SetPulse(period_ns, highTime_ns);
        }
    }
}
